Search
K
Policy

Metrics

Get policy metrics

Policy Metrics

post
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/metrics

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

PolicyMetricsRequest

startDatestring

Start Date

Example:2024-02-02

endDatestring

End Date

Example:2024-02-02

metricsarray[string]

Allowed values:LAPSEPROTECTIONPAYMENTAMOUNTACCOUNTSURRENDERVALUEACCOUNTVALUECOSTOFINSURANCENETDEATHBENEFITEXPENSECHARGEUNITEXPENSECHARGEINTERESTCREDITRATELOANREPAYMENTONETIMEAMOUNTSYSTEMATICLOANREPAYMENTAMOUNTINTERESTCREDITAMOUNTINTERESTLOANAMOUNTPARTIALWITHDRAWALONETIMEAMOUNTINITIALPREMIUMAMOUNTSUBSEQUENTPREMIUMAMOUNTONETIMEPREMIUMAMOUNTNEWLOANAMOUNTTOTALLOANBALANCETOTALCOVERAGEAMOUNTCUMULATIVEGROSSDEATHBENEFITAMOUNTCUMULATIVEPREMIUMSINCEISSUECOVERAGECHARGECOVERAGECREDITINITIALPREMIUMCALCULATEDAMOUNTSUBSEQUENTPREMIUMCALCULATEDAMOUNTONETIMEPREMIUMCALCULATEDAMOUNTSYSTEMATICWITHDRAWALAMOUNTFULLSURRENDERCHARGEPARTIALWITHDRAWALONETIMESURRENDERCHARGESYSTEMATICWITHDRAWALSURRENDERCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMESURRENDERCHARGEANNUITIZATIONPREMIUMTAXCHARGEDEATHPREMIUMTAXCHARGEFULLSURRENDERPREMIUMTAXCHARGEFULLSURRENDERMARKETVALUEADJUSTMENTCHARGEPARTIALWITHDRAWALONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICWITHDRAWALMARKETVALUEADJUSTMENTCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICREQUIREDMINIMUMDISTRIBUTIONMARKETVALUEADJUSTMENTCHARGERIDERCHARGEFIXEDINTERESTCREDITAMOUNTINDEXCREDITAMOUNTINITIALPREMIUMPAYMENTCHARGESUBSEQUENTPREMIUMPAYMENTCHARGEONETIMEPREMIUMPAYMENTCHARGEPREMIUMTAXAMOUNTFULLSURRENDERAMOUNTREQUIREDMINIMUMDISTRIBUTIONONETIMEAMOUNTSYSTEMATICREQUIREDMINIMUMDISTRIBUTIONAMOUNTSYSTEMATICREQUIREDMINIMUMDISTRIBUTIONSURRENDERCHARGECURRENTBASEHYPOTHETICALANNUALLIMITRATCHETBASEGROWTHBASEDEFERRALBONUSDEFERRALBONUSBASESIMPLEINTERESTBASEREMAININGBENEFITNETDECREASEINFACEAMOUNTNETINCREASEINFACEAMOUNT

Response

application/json

OK

metricstring

Requested metric

Example:LAPSEPROTECTIONPAYMENTAMOUNT

beginnumber(double)

TBD

Example:28.44

minimumnumber(double)

TBD

Example:28.44

maximumnumber(double)

TBD

Example:28.44

averagenumber(double)

TBD

Example:28.44

sumnumber(double)

TBD

Example:8389.8

countinteger(int64)

TBD

Example:295

endnumber(double)

TBD

Example:28.44

post/policy/v1/policies/{planCode}/{policyNumber}/metrics

Body

{}
 
application/json

Get IRI Policy Summary

get
https://qa.api.zinnia.io/policy-inquiry/v1/policies/{policyNumber}/summary

Query Parameters

associatedFirmIdstring

Optional firm/linkage identifier (preferred location per IRI).

Path Parameters

policyNumberstringrequired

Headers

correlationIdstring

Unique identifier to trace the request.

Response

application/json

OK

IriPolicySummary

effectiveDatestring(date)required

Policy effective date (yyyy-mm-dd).

Example:2021-01-15

cusipstring

CUSIP identifier for the product.

Match pattern:^[0-9]{3}[A-Z0-9]{5}[0-9]$

>= 9 characters<= 9 characters

Example:78462F103

carrierIdstringrequired

Carrier identifier.

<= 10 characters

Example:CARR123

carrierNamestring

Carrier display name.

<= 200 characters

Example:Contoso Life & Annuity

policyLastRefreshDateTimestring(date-time)required

Timestamp the policy data was last refreshed.

Example:2026-03-06T16:30:00Z

productobjectrequired
Show Child Parameters
qualificationTypestring

Tax qualification type.

Allowed values:Non-QualifiedSolo 401k401k403b457 Deferred CompensationInherited IRAIRA SpousalEducational IRAIRAIRA RolloverIRA TransferRoth IRARoth IRA - InheritedSEP IRASIMPLE IRAPension PlanCash Balance Plan-Defined ContributionsSolo Defined BenefitCash Balance Plan-Defined BenefitProfit Sharing PlanMoney Purchase PlanSAREP401gHR10Welfare Benefit PlanRoth 401KRoth 403bRoth 457

policyStatusstringrequired

Policy status.

Allowed values:PENDINGISSUEDACTIVELAPSEDSURRENDEREDTERMINATED

hasRestrictionboolean

Whether the policy has one or more active restrictions.

Example:true

restrictionsarray[object]

Active restrictions. Required when hasRestriction is true.

Show Child Parameters
issueTypestringrequired

Underwriting/issue type.

Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEED

issueStatestring

Two-letter issue state code.

Match pattern:^[A-Z]{2}$

Example:NC

currencystringrequired

ISO 4217 three-letter currency code.

Match pattern:^[A-Z]{3}$

Example:USD

get/policy-inquiry/v1/policies/{policyNumber}/summary
 
application/json

Get IRI Policy Value

get
https://qa.api.zinnia.io/policy-inquiry/v1/policies/{policyNumber}/values

Query Parameters

associatedFirmIdstring

Optional firm/linkage identifier (preferred location per IRI).

Path Parameters

policyNumberstringrequired

Headers

correlationIdstring

Unique identifier to trace the request.

Response

application/json

OK

IriPolicyValue

valuesAsOfDatestring(date)required

Date the values are reported as of (yyyy-mm-dd).

Example:2026-03-31

accountDesignationstring

Account designation / role type.

Allowed values:INDIVIDUALJOINTTRUSTCUSTODIALOTHER

jurisdictionstring

Two-letter jurisdiction code.

Match pattern:^[A-Z]{2}$

Example:NC

sponsoringPlanSeparationDatestring(date)

Sponsoring plan separation date (yyyy-mm-dd).

Example:2026-01-01

payoutTypestring

Payout / product type.

Allowed values:DEFERREDIMMEDIATEANNUITIZEDACCUMULATIONUNKNOWN

totalDepositITDnumber

Total deposit inception-to-date.

>= 0<= 9999999999.99

Example:0

surrenderChargeFreeDatestring(date)

Date surrender charges no longer apply (yyyy-mm-dd).

Example:2031-01-01

digitalPaymentTypeCodestring

Digital payment type code.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:ACH

digitalPaymentTypeDescriptionstring

Digital payment type description.

<= 100 characters

Example:Automated Clearing House

accountValuesobjectrequired
Show Child Parameters
loanValuesobject
Show Child Parameters
withdrawalValuesobject
Show Child Parameters
marketValueAdjustmentobject
Show Child Parameters
rmdInfoobject
Show Child Parameters
authorizationobject
Show Child Parameters
get/policy-inquiry/v1/policies/{policyNumber}/values
 
application/json

Get IRI Policy Parties

get
https://qa.api.zinnia.io/policy-inquiry/v1/policies/{policyNumber}/parties

Query Parameters

limitnumber

Page size (default 50, max 200)

startIndexnumber

Zero-based index of the first record to return

associatedFirmIdstring

Optional firm/linkage identifier (preferred location per IRI).

Path Parameters

policyNumberstringrequired

Headers

correlationIdstring

Unique identifier to trace the request.

Response

application/json

OK

IriPolicyParties

startIndexnumberrequired

Used for pagination to indicate where the returned page starts within the full result set.

>= 0

Example:0

itemsCountnumberrequired

Number of records included in the current response page.

>= 0

Example:1

totalItemsCountnumberrequired

Total number of records available that match the request criteria, independent of pagination.

>= 0

Example:1

partiesarray[object]required

Individuals or entities associated with the policy, including identity, relationship, and servicing instructions.

Show Child Parameters
get/policy-inquiry/v1/policies/{policyNumber}/parties
 
application/json